Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

crypto/kz4844: pass blobs by ref #1

Merged
merged 1 commit into from
May 11, 2024
Merged

crypto/kz4844: pass blobs by ref #1

merged 1 commit into from
May 11, 2024

Conversation

foxytanuki
Copy link
Owner

@foxytanuki foxytanuki commented May 11, 2024 •
edited by coderabbitai bot
Loading

This PR reflects the changes from ethereum/go-ethereum#29050 into suave-geth as well.

Summary by CodeRabbit

  • Refactor
    • Optimized cryptographic operations by updating function parameters to use pointers, enhancing performance and memory usage.
  • Tests
    • Adjusted test functions to align with the updated cryptographic function signatures.

@holiman @foxytanuki
crypto/kz4844: pass blobs by ref (#29050)
9a475d6 
This change makes use of the following underlying changes to the kzg-libraries in order to avoid passing large things on the stack:

- c-kzg: ethereum/c-kzg-4844#393 and
- go-kzg: https://github.com/crate-crypto/go-kzg-4844/pull/63
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented May 11, 2024 •
edited
Loading

Walkthrough

The recent updates across various files in the crypto/kzg4844 directory primarily involve changing function signatures to accept pointers to Blob structures instead of Blob values directly. This modification impacts functions related to commitment creation, proof computation, and proof verification, aiming to optimize memory usage and performance.

Changes

File(s) Change Summary
kzg4844.go, kzg4844_ckzg_cgo.go, kzg4844_ckzg_nocgo.go, kzg4844_gokzg.go Updated function signatures to accept *Blob (pointers to Blob) instead of Blob for various commitment and proof-related functions.
kzg4844_test.go Changed randBlob() function to return a pointer to Blob (*Blob).

🐰✨
In the realm of code, where Blobs are not few,
A rabbit hopped in, with changes anew.
Pointers they point, where values once stood,
Less copying around, for greater good!
Hop, skip, a commit, oh what a sight,
Performance leaps forward, into the night! 🌙
🐰✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@foxytanuki foxytanuki merged commit ddbc823 into main May 11, 2024
coderabbitai[bot]
coderabbitai bot reviewed May 11, 2024
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between c02d4a7 and 9a475d6.
Files selected for processing (5)
  • crypto/kzg4844/kzg4844.go (3 hunks)
  • crypto/kzg4844/kzg4844_ckzg_cgo.go (3 hunks)
  • crypto/kzg4844/kzg4844_ckzg_nocgo.go (2 hunks)
  • crypto/kzg4844/kzg4844_gokzg.go (3 hunks)
  • crypto/kzg4844/kzg4844_test.go (1 hunks)
Additional comments not posted (17)
crypto/kzg4844/kzg4844_ckzg_nocgo.go (4)

35-35: Change to pass Blob by reference is consistent with the PR's objectives to improve memory efficiency.

41-41: Updated function signature to use pointers aligns with memory optimization goals.

55-55: Signature change to pointer is appropriate for the intended memory optimizations.

60-60: Using pointers in function signature is a good practice for memory efficiency in this context.

crypto/kzg4844/kzg4844_gokzg.go (4)

49-52: Change to pass Blob by reference is consistent with the PR's objectives to improve memory efficiency.

61-64: Updated function signature to use pointers aligns with memory optimization goals.

83-86: Signature change to pointer is appropriate for the intended memory optimizations.

94-97: Using pointers in function signature is a good practice for memory efficiency in this context.

crypto/kzg4844/kzg4844.go (4)

68-68: Change to pass Blob by reference is consistent with the PR's objectives to improve memory efficiency.

77-77: Updated function signature to use pointers aligns with memory optimization goals.

97-97: Signature change to pointer is appropriate for the intended memory optimizations.

105-105: Using pointers in function signature is a good practice for memory efficiency in this context.

crypto/kzg4844/kzg4844_ckzg_cgo.go (4)

64-67: Change to pass Blob by reference is consistent with the PR's objectives to improve memory efficiency.

76-79: Updated function signature to use pointers aligns with memory optimization goals.

105-108: Signature change to pointer is appropriate for the intended memory optimizations.

116-119: Using pointers in function signature is a good practice for memory efficiency in this context.

crypto/kzg4844/kzg4844_test.go (1)

39-45: Change to return Blob by reference in test function aligns with changes in main code and improves consistency.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@foxytanuki @holiman